Skip to content

feat(react-router): parse regex to calculate accurate types for generatePath#13436

Closed
devonpmack wants to merge 3 commits intoremix-run:devfrom
devonpmack:dm/generate-path-improved-type
Closed

feat(react-router): parse regex to calculate accurate types for generatePath#13436
devonpmack wants to merge 3 commits intoremix-run:devfrom
devonpmack:dm/generate-path-improved-type

Conversation

@devonpmack
Copy link
Copy Markdown

@devonpmack devonpmack commented Apr 20, 2025 •
edited
Loading

When calling generatePath('/pages/:page(comments|latest_activity)') by parsing the regex, we should be able to automatically enforce that the page parameter is one of comments | latest_activity.

This PR implements that parsing:

  ExtractRouteParams<'/posts/:postId'> // { postId: string | null }>
  ExtractRouteParams<'/pages/:page(comments|latest_activity)'> // { page: 'comments' | 'latest_activity' | null }>
  ExtractRouteParams<'/page/:page(home|comments\d+)'> // { page: string | null }>,

If the path contains regex symbols like :page(\d+|activity) then it will not try to parse the types.

This could be a breaking change if anyone is incorrectly calling generatePath with arguments that aren't part of the (|) in the regexp.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 20, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 3b6f558

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Copy Markdown
Contributor

remix-cla-bot Bot commented Apr 20, 2025

Hi @devonpmack,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Copy Markdown
Contributor

remix-cla-bot Bot commented Apr 20, 2025

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@devonpmack devonpmack changed the base branch from main to dev April 20, 2025 16:10
@devonpmack devonpmack force-pushed the dm/generate-path-improved-type branch from 39091da to 1dc814b Compare April 20, 2025 16:17
@devonpmack devonpmack changed the title Parse regex for generate path Parse regex to calculate accurate types for generatePath Apr 20, 2025
@devonpmack devonpmack marked this pull request as ready for review April 20, 2025 16:21
@devonpmack
Copy link
Copy Markdown
Author

devonpmack commented May 7, 2025

@markdalgleish Hey Mark would it be possible to get this reviewed 🙏 Not sure who would be best to ping. Thank you!

@MichaelDeBoey MichaelDeBoey changed the title Parse regex to calculate accurate types for generatePath feat(react-router): parse regex to calculate accurate types for generatePath May 7, 2025
@brophdawg11
Copy link
Copy Markdown
Contributor

brophdawg11 commented May 8, 2025

I'll check in with the team but I'm not sure if we want to be continuing to try to enhance the type story here now that we have completely revamped the types with our Route.* typegen and (more specifically to this case) href helper. Is there a reason you can't migrate to framework mode to leverage those?

@brophdawg11 brophdawg11 removed their request for review May 8, 2025 14:07
@pcattori pcattori self-assigned this May 8, 2025
@devonpmack
Copy link
Copy Markdown
Author

devonpmack commented May 14, 2025

You're right framework mode would also fix it. But maybe this update is still worthwhile for people who haven't migrated yet?

@brophdawg11
Copy link
Copy Markdown
Contributor

brophdawg11 commented Jul 1, 2025

I'm going to close this for now according to our new Open Governance model. Please feel free to open a proposal for consideration/discussion.

@brophdawg11 brophdawg11 closed this Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markdalgleish markdalgleish Awaiting requested review from markdalgleish

Assignees

@pcattori pcattori

Labels

CLA Signed feat:typescript pkg:react-router

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@devonpmack @brophdawg11 @pcattori @MichaelDeBoey